<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

<html lang="en">
<head>

<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">

<meta name="generator" content="PHPDoctor 2RC4 (http://peej.github.com/phpdoctor/)">
<meta name="when" content="Mon, 02 May 2011 02:46:55 +0000">

<link rel="stylesheet" type="text/css" href="../stylesheet.css">
<link rel="start" href="../overview-summary.html">

<title>system (Cornice)</title>

</head>
<body id="definition" onload="parent.document.title=document.title;">

<div class="header">
<h1>Cornice</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../cornice/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../cornice/package-tree.html">Tree</a></li>
<li><a href="../overview-files.html">Files</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../todo-list.html">Todo</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../cornice\system.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<div class="qualifiedName">cornice\system</div>
<a href="../source/system.php.html#line14" class="location">system.php at line 14</a>

<h1>Class system</h1>

<pre class="tree"><strong>system</strong><br /></pre>

<hr>

<p class="signature">public  class <strong>system</strong></p>

<div class="comment" id="overview_description"><p>Main class of Cornice core</p></div>

<dl>
<dt>Author:</dt>
<dd>Nicola Dinh</dd>
<dt>Version:</dt>
<dd>2011.04.2216</dd>
</dl>
<hr>

<table id="summary_field">
<tr><th colspan="2">Field Summary</th></tr>
<tr>
<td class="type">static  mixed</td>
<td class="description"><p class="name"><a href="#blocks">$blocks</a></p></td>
</tr>
<tr>
<td class="type">static  mixed</td>
<td class="description"><p class="name"><a href="#devmode">$devmode</a></p></td>
</tr>
<tr>
<td class="type">static  mixed</td>
<td class="description"><p class="name"><a href="#lang">$lang</a></p></td>
</tr>
<tr>
<td class="type">static  mixed</td>
<td class="description"><p class="name"><a href="#skin">$skin</a></p></td>
</tr>
<tr>
<td class="type">static  mixed</td>
<td class="description"><p class="name"><a href="#title">$title</a></p></td>
</tr>
<tr>
<td class="type">static  mixed</td>
<td class="description"><p class="name"><a href="#website">$website</a></p></td>
</tr>
</table>

<table id="summary_method">
<tr><th colspan="2">Method Summary</th></tr>
<tr>
<td class="type"> void</td>
<td class="description"><p class="name"><a href="#__construct()">__construct</a>()</p><p class="description">Default instance level constructor
Just decorative, should not be called due to having only static methods</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#break_all_buffers()">break_all_buffers</a>()</p><p class="description">Break all output buffers (those started by ob_start)</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#check_preferences()">check_preferences</a>()</p><p class="description">Check user's preferences (skin & language)</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#check_security()">check_security</a>()</p><p class="description">Check module accessibility</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#get_block()">get_block</a>(string block, mixed module)</p><p class="description">Get instance of a block</p></td>
</tr>
<tr>
<td class="type">static  array</td>
<td class="description"><p class="name"><a href="#get_module_info()">get_module_info</a>()</p><p class="description">Get requested module information (from module xml)</p></td>
</tr>
<tr>
<td class="type">static  array</td>
<td class="description"><p class="name"><a href="#get_module_list()">get_module_list</a>()</p><p class="description">Get list of existing modules (xml files in 'modules' directory)</p></td>
</tr>
<tr>
<td class="type">static  array</td>
<td class="description"><p class="name"><a href="#get_page_info()">get_page_info</a>()</p><p class="description">Get requested page information (from page xml)</p></td>
</tr>
<tr>
<td class="type">static  array</td>
<td class="description"><p class="name"><a href="#get_protected_modules()">get_protected_modules</a>()</p><p class="description">Get list of protected modules</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#initialise_all()">initialise_all</a>()</p><p class="description">Initialise all classes (mostly static ones)</p></td>
</tr>
<tr>
<td class="type">static  boolean</td>
<td class="description"><p class="name"><a href="#is_localhost()">is_localhost</a>()</p><p class="description">Check if script called from localhost, meaning whether the web browser
running on server or on a network computer</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#layout()">layout</a>()</p><p class="description">Get created layout object</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#load_core_classes()">load_core_classes</a>()</p><p class="description">Load all core classes</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#load_custom_classes()">load_custom_classes</a>()</p><p class="description">Load all custom classes</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#load_module_info()">load_module_info</a>()</p><p class="description">Load module information (from 'modules/module.xml')</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#load_page_info()">load_page_info</a>()</p><p class="description">Load page information (from 'mcv/pages/views/xml/page.xml')</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#module_auth_passed()">module_auth_passed</a>()</p><p class="description">Module authentication page should call this function when the 
requirements for accessing the module are all fulfilled.</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#page()">page</a>()</p><p class="description">Get created page object</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#render_page()">render_page</a>()</p><p class="description">Render the requested page</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#render_webpage()">render_webpage</a>()</p><p class="description">Render the whole web page</p></td>
</tr>
<tr>
<td class="type">static  void</td>
<td class="description"><p class="name"><a href="#sign_out()">sign_out</a>()</p><p class="description">Perform a sign-out action</p></td>
</tr>
</table>

<h2 id="detail_field">Field Detail</h2>
<a href="../source/system.php.html#line28" class="location">system.php at line 28</a>

<h3 id="blocks">blocks</h3>
<code class="signature">public static  mixed <strong>$blocks</strong> = array()</code>
<div class="details">
</div>

<hr>

<a href="../source/system.php.html#line19" class="location">system.php at line 19</a>

<h3 id="devmode">devmode</h3>
<code class="signature">public static  mixed <strong>$devmode</strong> = false</code>
<div class="details">
</div>

<hr>

<a href="../source/system.php.html#line24" class="location">system.php at line 24</a>

<h3 id="lang">lang</h3>
<code class="signature">public static  mixed <strong>$lang</strong> = null</code>
<div class="details">
</div>

<hr>

<a href="../source/system.php.html#line23" class="location">system.php at line 23</a>

<h3 id="skin">skin</h3>
<code class="signature">public static  mixed <strong>$skin</strong> = null</code>
<div class="details">
</div>

<hr>

<a href="../source/system.php.html#line30" class="location">system.php at line 30</a>

<h3 id="title">title</h3>
<code class="signature">public static  mixed <strong>$title</strong> = null</code>
<div class="details">
</div>

<hr>

<a href="../source/system.php.html#line31" class="location">system.php at line 31</a>

<h3 id="website">website</h3>
<code class="signature">public static  mixed <strong>$website</strong> = null</code>
<div class="details">
</div>

<hr>

<h2 id="detail_method">Method Detail</h2>
<a href="../source/system.php.html#line37" class="location">system.php at line 37</a>

<h3 id="__construct()">__construct</h3>
<code class="signature">public  void <strong>__construct</strong>()</code>
<div class="details">
<p>Default instance level constructor
Just decorative, should not be called due to having only static methods</p></div>

<hr>

<a href="../source/system.php.html#line395" class="location">system.php at line 395</a>

<h3 id="break_all_buffers()">break_all_buffers</h3>
<code class="signature">public static  void <strong>break_all_buffers</strong>()</code>
<div class="details">
<p>Break all output buffers (those started by ob_start)</p></div>

<hr>

<a href="../source/system.php.html#line466" class="location">system.php at line 466</a>

<h3 id="check_preferences()">check_preferences</h3>
<code class="signature">public static  void <strong>check_preferences</strong>()</code>
<div class="details">
<p>Check user's preferences (skin & language)</p></div>

<hr>

<a href="../source/system.php.html#line435" class="location">system.php at line 435</a>

<h3 id="check_security()">check_security</h3>
<code class="signature">public static  void <strong>check_security</strong>()</code>
<div class="details">
<p>Check module accessibility</p></div>

<hr>

<a href="../source/system.php.html#line235" class="location">system.php at line 235</a>

<h3 id="get_block()">get_block</h3>
<code class="signature">public static  void <strong>get_block</strong>(string block, mixed module)</code>
<div class="details">
<p>Get instance of a block</p><dl>
<dt>Parameters:</dt>
<dd>block - The name of block (eg. 'menu','header',...)</dd>
</dl>
</div>

<hr>

<a href="../source/system.php.html#line45" class="location">system.php at line 45</a>

<h3 id="get_module_info()">get_module_info</h3>
<code class="signature">public static  array <strong>get_module_info</strong>()</code>
<div class="details">
<p>Get requested module information (from module xml)</p><dl>
<dt>Returns:</dt>
<dd>The array parsed from module xml</dd>
</dl>
</div>

<hr>

<a href="../source/system.php.html#line347" class="location">system.php at line 347</a>

<h3 id="get_module_list()">get_module_list</h3>
<code class="signature">public static  array <strong>get_module_list</strong>()</code>
<div class="details">
<p>Get list of existing modules (xml files in 'modules' directory)</p><dl>
<dt>Returns:</dt>
<dd>The list of modules</dd>
</dl>
</div>

<hr>

<a href="../source/system.php.html#line53" class="location">system.php at line 53</a>

<h3 id="get_page_info()">get_page_info</h3>
<code class="signature">public static  array <strong>get_page_info</strong>()</code>
<div class="details">
<p>Get requested page information (from page xml)</p><dl>
<dt>Returns:</dt>
<dd>The array parsed from page xml</dd>
</dl>
</div>

<hr>

<a href="../source/system.php.html#line366" class="location">system.php at line 366</a>

<h3 id="get_protected_modules()">get_protected_modules</h3>
<code class="signature">public static  array <strong>get_protected_modules</strong>()</code>
<div class="details">
<p>Get list of protected modules</p><dl>
<dt>Returns:</dt>
<dd>The list of protected modules</dd>
</dl>
</div>

<hr>

<a href="../source/system.php.html#line291" class="location">system.php at line 291</a>

<h3 id="initialise_all()">initialise_all</h3>
<code class="signature">public static  void <strong>initialise_all</strong>()</code>
<div class="details">
<p>Initialise all classes (mostly static ones)</p></div>

<hr>

<a href="../source/system.php.html#line512" class="location">system.php at line 512</a>

<h3 id="is_localhost()">is_localhost</h3>
<code class="signature">public static  boolean <strong>is_localhost</strong>()</code>
<div class="details">
<p>Check if script called from localhost, meaning whether the web browser
running on server or on a network computer</p><dl>
<dt>Returns:</dt>
<dd>'true' if called from localhost</dd>
</dl>
</div>

<hr>

<a href="../source/system.php.html#line496" class="location">system.php at line 496</a>

<h3 id="layout()">layout</h3>
<code class="signature">public static  void <strong>layout</strong>()</code>
<div class="details">
<p>Get created layout object</p></div>

<hr>

<a href="../source/system.php.html#line90" class="location">system.php at line 90</a>

<h3 id="load_core_classes()">load_core_classes</h3>
<code class="signature">public static  void <strong>load_core_classes</strong>()</code>
<div class="details">
<p>Load all core classes</p></div>

<hr>

<a href="../source/system.php.html#line99" class="location">system.php at line 99</a>

<h3 id="load_custom_classes()">load_custom_classes</h3>
<code class="signature">public static  void <strong>load_custom_classes</strong>()</code>
<div class="details">
<p>Load all custom classes</p></div>

<hr>

<a href="../source/system.php.html#line108" class="location">system.php at line 108</a>

<h3 id="load_module_info()">load_module_info</h3>
<code class="signature">public static  void <strong>load_module_info</strong>()</code>
<div class="details">
<p>Load module information (from 'modules/module.xml')</p></div>

<hr>

<a href="../source/system.php.html#line125" class="location">system.php at line 125</a>

<h3 id="load_page_info()">load_page_info</h3>
<code class="signature">public static  void <strong>load_page_info</strong>()</code>
<div class="details">
<p>Load page information (from 'mcv/pages/views/xml/page.xml')</p></div>

<hr>

<a href="../source/system.php.html#line311" class="location">system.php at line 311</a>

<h3 id="module_auth_passed()">module_auth_passed</h3>
<code class="signature">public static  void <strong>module_auth_passed</strong>()</code>
<div class="details">
<p>Module authentication page should call this function when the 
requirements for accessing the module are all fulfilled.</p></div>

<hr>

<a href="../source/system.php.html#line503" class="location">system.php at line 503</a>

<h3 id="page()">page</h3>
<code class="signature">public static  void <strong>page</strong>()</code>
<div class="details">
<p>Get created page object</p></div>

<hr>

<a href="../source/system.php.html#line539" class="location">system.php at line 539</a>

<h3 id="render_page()">render_page</h3>
<code class="signature">public static  void <strong>render_page</strong>()</code>
<div class="details">
<p>Render the requested page</p></div>

<hr>

<a href="../source/system.php.html#line547" class="location">system.php at line 547</a>

<h3 id="render_webpage()">render_webpage</h3>
<code class="signature">public static  void <strong>render_webpage</strong>()</code>
<div class="details">
<p>Render the whole web page</p></div>

<hr>

<a href="../source/system.php.html#line319" class="location">system.php at line 319</a>

<h3 id="sign_out()">sign_out</h3>
<code class="signature">public static  void <strong>sign_out</strong>()</code>
<div class="details">
<p>Perform a sign-out action</p></div>

<hr>

<div class="header">
<h1>Cornice</h1>
<ul>
<li><a href="../overview-summary.html">Overview</a></li>
<li><a href="../cornice/package-summary.html">Package</a></li>
<li class="active">Class</li>
<li><a href="../cornice/package-tree.html">Tree</a></li>
<li><a href="../overview-files.html">Files</a></li>
<li><a href="../deprecated-list.html">Deprecated</a></li>
<li><a href="../todo-list.html">Todo</a></li>
<li><a href="../index-all.html">Index</a></li>
</ul>
</div>

<div class="small_links">
<a href="../index.html" target="_top">Frames</a>
<a href="../cornice\system.html" target="_top">No frames</a>
</div>
<div class="small_links">
Summary: <a href="#summary_field">Field</a> | <a href="#summary_method">Method</a> | <a href="#summary_constr">Constr</a>
Detail: <a href="#detail_field">Field</a> | <a href="#detail_method">Method</a> | <a href="#summary_constr">Constr</a>
</div>
<hr>

<p id="footer">This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a></p>

</body>

</html>